/**
 * 
 */
package fr.kptn.musixmatchwrapper.dto.lyrics;

import com.google.gson.annotations.SerializedName;

/**
 * Informations on lyrics of a track
 * 
 * @author Sylvain
 * 
 */
public class Lyrics {

	/** musiXmatch identifier of the lyrics **/
	@SerializedName("lyrics_id")
	private int mLyricsId;

	/** The lyrics **/
	@SerializedName("lyrics_body")
	private String mLyricsBody;

	/** The country code representing the language of the lyrics **/
	@SerializedName("lyrics_language")
	private String mLyricsLanguage;

	/** Indicates if the use of the lyrics is restricted (1) or not (0) **/
	@SerializedName("restricted")
	private int mRestricted;

	/**
	 * Indicates if the track corresponding to these lyrics is instrumental (1)
	 * or not (0)
	 **/
	@SerializedName("instrumental")
	private int mInstrumental;

	/** The copyright associated with these lyrics **/
	@SerializedName("lyrics_copyright")
	private String mLyricsCopyright;

	/**
	 * The URL of an image to track the use of these lyrics.This image must be
	 * included where you use the lyrics. If this image is not included you MUST
	 * include the image representing in the <code>mScriptTrackingURL</code>
	 * member.
	 **/
	@SerializedName("pixel_tracking_url")
	private String mPixelTrackingURL;

	/**
	 * The URL of a script to track the use of these lyrics. This script must be
	 * included where you use the lyrics. If this script is not included you
	 * MUST include the image representing in the <code>mPixelTrackingURL</code>
	 * member.
	 **/
	@SerializedName("script_tracking_url")
	private String mScriptTrackingURL;

	/**
	 * @return the lyricsId
	 */
	public int getLyricsId() {
		return mLyricsId;
	}

	/**
	 * @param pLyricsId
	 *            the lyricsId to set
	 */
	public void setLyricsId(int pLyricsId) {
		mLyricsId = pLyricsId;
	}

	/**
	 * @return the lyricsBody
	 */
	public String getLyricsBody() {
		return mLyricsBody;
	}

	/**
	 * @param pLyricsBody
	 *            the lyricsBody to set
	 */
	public void setLyricsBody(String pLyricsBody) {
		mLyricsBody = pLyricsBody;
	}

	/**
	 * @return the lyricsLanguage
	 */
	public String getLyricsLanguage() {
		return mLyricsLanguage;
	}

	/**
	 * @param pLyricsLanguage
	 *            the lyricsLanguage to set
	 */
	public void setLyricsLanguage(String pLyricsLanguage) {
		mLyricsLanguage = pLyricsLanguage;
	}

	/**
	 * @return the restricted
	 */
	public int getRestricted() {
		return mRestricted;
	}

	/**
	 * @param pRestricted
	 *            the restricted to set
	 */
	public void setRestricted(int pRestricted) {
		mRestricted = pRestricted;
	}

	/**
	 * @return the instrumental
	 */
	public int getInstrumental() {
		return mInstrumental;
	}

	/**
	 * @param pInstrumental
	 *            the instrumental to set
	 */
	public void setInstrumental(int pInstrumental) {
		mInstrumental = pInstrumental;
	}

	/**
	 * @return the lyricsCopyright
	 */
	public String getLyricsCopyright() {
		return mLyricsCopyright;
	}

	/**
	 * @param pLyricsCopyright
	 *            the lyricsCopyright to set
	 */
	public void setLyricsCopyright(String pLyricsCopyright) {
		mLyricsCopyright = pLyricsCopyright;
	}

	/**
	 * @return the pixelTrackingURL
	 */
	public String getPixelTrackingURL() {
		return mPixelTrackingURL;
	}

	/**
	 * @param pPixelTrackingURL
	 *            the pixelTrackingURL to set
	 */
	public void setPixelTrackingURL(String pPixelTrackingURL) {
		mPixelTrackingURL = pPixelTrackingURL;
	}

	/**
	 * @return the scriptTrackingURL
	 */
	public String getScriptTrackingURL() {
		return mScriptTrackingURL;
	}

	/**
	 * @param pScriptTrackingURL
	 *            the scriptTrackingURL to set
	 */
	public void setScriptTrackingURL(String pScriptTrackingURL) {
		mScriptTrackingURL = pScriptTrackingURL;
	}
}
